/*
	Copyright (c) 2010, Mathias Myrland, Myrland Systemutvikling (mathias@myrsys.no)
	All rights reserved.

	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions are met:
	
	    * Redistributions of source code must retain the above copyright
	      notice, this list of conditions and the following disclaimer.
	      
	    * Redistributions in binary form must reproduce the above copyright
	      notice, this list of conditions and the following disclaimer in the
	      documentation and/or other materials provided with the distribution.
	      
	    * Neither the name of Myrland Systemutvikling nor the
	      names of its contributors may be used to endorse or promote products
	      derived from this software without specific prior written permission.

	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
	ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	DISCLAIMED. IN NO EVENT SHALL Myrland Systemutvikling BE LIABLE FOR ANY
	DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef CGF_EVENT_HPP
#define CGF_EVENT_HPP

#include <queue>
#include <cgf/signal.hpp>
#include <cgf/managedcontainer.hpp>


namespace CGF
{
	class ComponentFactory;
	
	/**
	*	This is the event object which is passed around. It provides little more than a tangible implementation of the Object class' property and class system.	*/
	class Event : public SignalProducer<Event>
	{
		public:
			
			/**	This is the logic cycle at which this event was posted	*/
			uint64_t m_timestamp;
		
			Event( uint64_t ts ) : m_timestamp ( ts ) { this->addClass ( "event" ); }
			~Event() {}
	};
	
	
	class EventCapable
	{
		ManagedContainer<Event, std::list, boost::shared_ptr > m_eventQueue;
		ManagedContainer<Event, std::list> m_listenQueue;
		
		boost::unordered_map<void*, boost::signals::connection>  m_connections;
		
		public:
			
			boost::unordered_map<void*, boost::signals::connection>& connections() { return m_connections; }
			
		
			SignalProducer<Event> signals;
		
			/**
			*	emitts an event by calling the emittEvent signal, passing along the shared ptr.
			*	@param	event	The event that is being emitted	*/
			void emittEvent( boost::shared_ptr<Event> );
			
			/**
			*	Monitor events from a component factory	*/
			void monitorEvent ( boost::shared_ptr<ComponentFactory>, std::string );
		
		
			/**
			*	Callback for monitoring events	*/
			void eventCallback ( boost::shared_ptr<Event> );
		
			/**
			*	Monitor events from an event capable object. All events from this producer is placed in the m_listenQueue
			*	@param	producer	The producer we wish to monitor. */
			void monitorProducer ( boost::shared_ptr<EventCapable> );
		
			/**
			*	Stop monitoring events from the provided event producer
			*	@param	producer	The producer to disconnect	*/
			void disconnectProducer ( boost::shared_ptr<EventCapable> );
			
			ManagedContainer<Event, std::list, boost::shared_ptr >& eventQueue();
			ManagedContainer<Event, std::list>& listenQueue();
			
			virtual ~EventCapable() {}
	};
	
}//	namespace CGF
#endif
